Skip to main content
POST
Enviar Mensagem SMS
A rota POST /api/v1/message/sms permite o envio direto de mensagens de texto curtas (SMS) para um ou mais destinatários. Esta API é ideal para notificações rápidas, alertas de sistema, mensagens informativas e comunicações diretas com o cliente final.

Request Body

to
string[]
required
Lista de números de telefone dos destinatários que receberão o SMS. Os números devem conter o código do país, DDD e o número do celular.Exemplo: ["+55119912341234"]
message
string
required
O conteúdo em texto da mensagem que será transmitida. Recomenda-se evitar caracteres especiais para garantir a compatibilidade com todas as operadoras.Exemplo: Olá! Seu código de acesso expirará em breve.
externalId
string
Identificador opcional de controle utilizado pelo sistema cliente para correlacionar o envio do SMS com um evento interno de sua plataforma.Exemplo: 05be75cc-8f8a-414a-891f-434aa9b4e7a5

Response

Retorna síncronamente a confirmação de que o processo de envio foi iniciado, acompanhado do identificador único do disparo e o status atual da requisição.

Exemplo de sucesso (201 Created)